<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>tiger: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-testsrcbin.html" title="testsrc">
<link rel="next" href="gst-plugins-bad-plugins-timecodestamper.html" title="timecodestamper">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-tiger.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-tiger.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-plugins-testsrcbin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-plugins-timecodestamper.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-plugins-tiger"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-tiger.top_of_page"></a>tiger</span></h2>
<p>tiger</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--category" title="The “category” property">category</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-alpha" title="The “default-background-alpha” property">default-background-alpha</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-blue" title="The “default-background-blue” property">default-background-blue</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-green" title="The “default-background-green” property">default-background-green</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-background-red" title="The “default-background-red” property">default-background-red</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-alpha" title="The “default-font-alpha” property">default-font-alpha</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-blue" title="The “default-font-blue” property">default-font-blue</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-desc" title="The “default-font-desc” property">default-font-desc</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstFontEffect</span></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-effect" title="The “default-font-effect” property">default-font-effect</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-effect-strength" title="The “default-font-effect-strength” property">default-font-effect-strength</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-green" title="The “default-font-green” property">default-font-green</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--default-font-red" title="The “default-font-red” property">default-font-red</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--language" title="The “language” property">language</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--original-canvas-height" title="The “original-canvas-height” property">original-canvas-height</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--original-canvas-width" title="The “original-canvas-width” property">original-canvas-width</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger--quality" title="The “quality” property">quality</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-tiger.html#GstKateTiger" title="struct GstKateTiger">GstKateTiger</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.description"></a><h2>Description</h2>
<p>This element decodes and renders Kate streams</p>
<a class="ulink" href="http://libkate.googlecode.com/" target="_top">Kate</a> is a free codec
<p>for text based data, such as subtitles. Any number of kate streams can be
embedded in an Ogg stream.</p>
<p>libkate (see above url) and <a class="ulink" href="http://libtiger.googlecode.com/" target="_top">libtiger</a>
are needed to build this element.</p>
<div class="refsect3">
<a name="id-1.2.219.5.6"></a><h4>Example pipeline</h4>
<p>This pipeline renders a Kate stream on top of a Theora video multiplexed
in the same stream:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> \
  filesrc location<span class="gtkdoc opt">=</span>video<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux name<span class="gtkdoc opt">=</span>demux \
  demux<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> theoradec <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> tiger name<span class="gtkdoc opt">=</span>tiger \
  demux<span class="gtkdoc opt">. !</span> queue <span class="gtkdoc opt">!</span> kateparse <span class="gtkdoc opt">!</span> tiger<span class="gtkdoc opt">.</span> \
  tiger<span class="gtkdoc opt">. !</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstKateTiger"></a><h3>struct GstKateTiger</h3>
<pre class="programlisting">struct GstKateTiger {
  GstKateDecoderBase decoder;

  GstPad *katesinkpad;
  GstPad *videosinkpad;
  GstPad *srcpad;

  tiger_renderer *tr;

  gdouble quality;
  gchar *default_font_desc;
  gboolean default_font_effect;
  gdouble default_font_effect_strength;
  guchar default_font_r;
  guchar default_font_g;
  guchar default_font_b;
  guchar default_font_a;
  guchar default_background_r;
  guchar default_background_g;
  guchar default_background_b;
  guchar default_background_a;
  gboolean silent;

  GstVideoFormat video_format;
  gint video_width;
  gint video_height;
  gboolean swap_rgb;
  GstBuffer *render_buffer;
  GstVideoOverlayComposition *composition;

  GMutex *mutex;
  GCond *cond;

  GstSegment video_segment;
  gboolean video_flushing;
  gboolean seen_header;
};
</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstKateTiger--category"></a><h3>The <code class="literal">“category”</code> property</h3>
<pre class="programlisting">  “category”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The category of the stream.</p>
<p>Flags: Read</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-background-alpha"></a><h3>The <code class="literal">“default-background-alpha”</code> property</h3>
<pre class="programlisting">  “default-background-alpha” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default background color (alpha component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-background-blue"></a><h3>The <code class="literal">“default-background-blue”</code> property</h3>
<pre class="programlisting">  “default-background-blue”  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default background color (blue component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-background-green"></a><h3>The <code class="literal">“default-background-green”</code> property</h3>
<pre class="programlisting">  “default-background-green” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default background color (green component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-background-red"></a><h3>The <code class="literal">“default-background-red”</code> property</h3>
<pre class="programlisting">  “default-background-red”   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default background color (red component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-alpha"></a><h3>The <code class="literal">“default-font-alpha”</code> property</h3>
<pre class="programlisting">  “default-font-alpha”       <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default font color (alpha component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-blue"></a><h3>The <code class="literal">“default-font-blue”</code> property</h3>
<pre class="programlisting">  “default-font-blue”        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default font color (blue component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-desc"></a><h3>The <code class="literal">“default-font-desc”</code> property</h3>
<pre class="programlisting">  “default-font-desc”        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Default font description (Pango style) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-effect"></a><h3>The <code class="literal">“default-font-effect”</code> property</h3>
<pre class="programlisting">  “default-font-effect”      <span class="type">GstFontEffect</span></pre>
<p>Whether to apply an effect to text by default, for increased readability.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: outline</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-effect-strength"></a><h3>The <code class="literal">“default-font-effect-strength”</code> property</h3>
<pre class="programlisting">  “default-font-effect-strength” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>How pronounced should the font effect be (effect dependent).</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.5</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-green"></a><h3>The <code class="literal">“default-font-green”</code> property</h3>
<pre class="programlisting">  “default-font-green”       <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default font color (green component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--default-font-red"></a><h3>The <code class="literal">“default-font-red”</code> property</h3>
<pre class="programlisting">  “default-font-red”         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Default font color (red component, between 0 and 255) to render text with.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,255]</p>
<p>Default value: 255</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--language"></a><h3>The <code class="literal">“language”</code> property</h3>
<pre class="programlisting">  “language”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The language of the stream.</p>
<p>Flags: Read</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--original-canvas-height"></a><h3>The <code class="literal">“original-canvas-height”</code> property</h3>
<pre class="programlisting">  “original-canvas-height”   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The canvas height this stream was authored for (0 is unspecified).</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--original-canvas-width"></a><h3>The <code class="literal">“original-canvas-width”</code> property</h3>
<pre class="programlisting">  “original-canvas-width”    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The canvas width this stream was authored for.</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstKateTiger--quality"></a><h3>The <code class="literal">“quality”</code> property</h3>
<pre class="programlisting">  “quality”                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Rendering quality (0 is faster, 1 is best and slower).</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-tiger.see-also"></a><h2>See Also</h2>
<p>katedec</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>